ZE and ZE API readme updates #3365
Conversation
Signed-off-by: Adam Wolfe <[email protected]>
adam-wolfe
added
the
no-changelog
|
📅 Suggested merge-by date: 1/1/2025 |
Signed-off-by: adam-wolfe <[email protected]>
Signed-off-by: adam-wolfe <[email protected]>
Signed-off-by: adam-wolfe <[email protected]>
adam-wolfe
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3365 +/- ##
=======================================
Coverage 93.17% 93.17%
=======================================
Files 117 117
Lines 12277 12277
Branches 2822 2822
=======================================
Hits 11439 11439
Misses 837 837
Partials 1 1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Thanks for adding these updates @adam-wolfe, did leave a comment for small grammar change and a comment for discussion with squad at later time.
| However, the current API is being used by other extensions already, such as for Zowe Explorer with the [Zowe Explorer FTP Extension](../zowe-explorer-ftp-extension) that you can find in this same Git repository, as well as for commercial extensions maintained by Zowe's contributors and available on their company websites. | ||
|
|
||
| Currently, the API is organized into two modules, which both are rolled up into the top-level `index.ts` file for convenient access. | ||
| The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. |
There was a problem hiding this comment.
Comment here isn't for the sentence itself but about the changed access to modules, removing the access directly to the /profiles module was a huge breaking change I saw for extenders that use our profile ZE APIs in a CLI plugin. Bringing attention here for discussion.
Signed-off-by: adam-wolfe <[email protected]>
There was a problem hiding this comment.
Good timing! I noticed this when reading this page earlier today, that this line the link to packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpApi.ts now goes to a 404.
Signed-off-by: adam-wolfe <[email protected]>
Signed-off-by: adam-wolfe <[email protected]>
|
As I dig into the Zowe Explorer API readme, I'm realizing that this is a bit more tangled than I realized. I've made all of the easy changes. After the holidays, we should update the Zowe Explorer API readme to describe the current state of the modules. |
zFernand0
requested review from
anaxceron,
JillieBeanSim and
Buckminsterfullerene02
and removed request for
Buckminsterfullerene02
There was a problem hiding this comment.
thanks for pushing updates for comments @adam-wolfe. With the comment about other broken links we should update the zFTP package links in this file being updated to full path for access from npmjs. I also got a 404 when clicking the link for the zFTP package in npmjs
https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension
Signed-off-by: adam-wolfe <[email protected]>
Signed-off-by: adam-wolfe <[email protected]>
|
I've revised some of the wording. Let me know what you think. |
looks like there are numerous relative paths to the zFTP extension in the ZE API README, could they all be changed to full browser paths to work from outside the repository please. Thanks |
Signed-off-by: adam-wolfe <[email protected]>
Should be good now |
Proposed changes
For the ZE API readme
For the ZE readme:
In the future, we should consider providing more detail on the other modules available from the ZE API package or possibly providing some other form of API documentation (e.g., typedoc).
Release Notes
Milestone:
Changelog:
Types of changes
Checklist
General
yarn workspace vscode-extension-for-zowe vscode:prepublishpnpm --filter vscode-extension-for-zowe vscode:prepublishCode coverage
Deployment
Further comments